aviutl2\generic\binding/
mod.rs

1use crate::common::{AnyResult, AviUtl2Info};
2
3/// 汎用プラグインの情報を表す構造体。
4#[derive(Debug, Clone)]
5pub struct FilterPluginTable {
6    /// プラグインの情報。
7    /// 「プラグイン情報」ダイアログで表示されます。
8    pub information: String,
9}
10
11/// 汎用プラグインのトレイト。
12/// このトレイトを実装し、[`crate::register_generic_plugin!`] マクロを使用してプラグインを登録します。
13pub trait GenericPlugin: Send + Sync + Sized {
14    /// プラグインを初期化する。
15    fn new(info: AviUtl2Info) -> AnyResult<Self>;
16
17    /// プラグインをホストに登録する。
18    fn register(&mut self, registry: &mut self::host_app::HostAppHandle);
19
20    /// プロジェクトファイルのロードを処理する。
21    ///
22    /// プロジェクトの初期化時にも呼ばれます。
23    fn on_project_load(&mut self, _project: &mut crate::generic::ProjectFile) {}
24
25    /// プロジェクトファイルをセーブする直前に呼ばれる。
26    fn on_project_save(&mut self, _project: &mut crate::generic::ProjectFile) {}
27
28    /// シングルトンインスタンスを参照するためのヘルパーメソッド。
29    ///
30    /// # Panics
31    ///
32    /// プラグインが初期化されていない場合や、二重に呼び出された場合にパニックします。
33    fn with_instance<R>(f: impl FnOnce(&Self) -> R) -> R
34    where
35        Self: crate::generic::__bridge::GenericSingleton,
36    {
37        <Self as crate::generic::__bridge::GenericSingleton>::with_instance(f)
38    }
39
40    /// シングルトンインスタンスを可変参照するためのヘルパーメソッド。
41    ///
42    /// # Panics
43    ///
44    /// プラグインが初期化されていない場合や、二重に呼び出された場合にパニックします。
45    fn with_instance_mut<R>(f: impl FnOnce(&mut Self) -> R) -> R
46    where
47        Self: crate::generic::__bridge::GenericSingleton,
48    {
49        <Self as crate::generic::__bridge::GenericSingleton>::with_instance_mut(f)
50    }
51}
52
53mod project;
54pub use project::*;
55mod edit_section;
56pub use edit_section::*;
57mod host_app;
58pub use host_app::*;